Skip to content

docs: add the implementation-record template - #3

Merged
mertefesensoy merged 1 commit into
mainfrom
docs/implementation-template
Nov 16, 2026
Merged

mertefesensoy merged 1 commit into
mainfrom
docs/implementation-template

Conversation

@mertefesensoy

Copy link
Copy Markdown
Member

Adds docs/implementations/_TEMPLATE.md, the template every implementation record is meant to follow, and a record of this change.

The template has the seven required sections in order (Problem / Motivation, What Changed, Implementation Approach, Mathematical / Statistical Details, Design Decisions, Verification, Related Docs). Each has an HTML comment saying what belongs in it; comments do not render on GitHub.

The same file goes into ddr4-udimm, spdr and .github, one pull request each. Existing records are not changed.

Check: git hash-object docs/implementations/_TEMPLATE.md gives 6df8c0e6b212496b2b38658fb43e6bba1dcf11b6 in all three repositories.

@mertefesensoy
mertefesensoy merged commit 991c514 into main Nov 16, 2026
1 check passed
@mertefesensoy
mertefesensoy deleted the docs/implementation-template branch November 16, 2026 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant